Function Reference

_TS_FolderCreate

Creates a Task Folder.

#Include <TaskScheduler.au3>
_TS_FolderCreate($oService, $sFolder)

 

Parameters

$oService Task Scheduler Service object as returned by _TS_Open
$sFolder The name that is used to identify the Folder. It is created on the root Folder

 

Return Value

Success: Object of the created Task Folder
Failure: Returns 0 and sets @error:
    601 - Error accessing the TaskFolder collection. @extended is set to the COM error code
    602 - Specified $sFolder already exists
    603 - Error creating the specified TaskFolder. @extended is set to the COM error code

 

Remarks

$sFolder has always to start at the root Folder (means you have to specify all the Folders from the root down even when they already exist)

 

Related

 

Example


#Region ;**** Directives created by AutoIt3Wrapper_GUI ****
#AutoIt3Wrapper_Res_requestedExecutionLevel=asInvoker
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=y
#AutoIt3Wrapper_AU3Check_Parameters=-d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6 -w 7
#EndRegion ;**** Directives created by AutoIt3Wrapper_GUI ****

#include <TaskScheduler.au3>
#include <Array.au3>

; *****************************************************************************
; Connect to the Task Scheduler Service
; *****************************************************************************
Global $oService = _TS_Open()
If @error <> 0 Then Exit MsgBox($MB_ICONERROR, "Task Scheduler UDF", "Error connecting to the Task Scheduler Service. @error = " & @error & ", @extended = " & @extended & @CRLF & @CRLF & _TS_ErrorText(@error))

; *****************************************************************************
; Create a new folder
; $sFolder has always to start at the root folder (means you have to
; specify all the folders from the root down even when they already exist)
; *****************************************************************************
Global $sFolder = "\Test-Level-0\Test-Level-1"
Global $aTaskProperties = _TS_FolderCreate($oService, $sFolder)
If Not @error Then
    MsgBox($MB_ICONINFORMATION, "_TS_FolderCreate", "Folder: " & $sFolder & " successfully created!")
Else
    MsgBox($MB_ICONERROR, "_TS_FolderCreate", "Returned @error=" & @error & ", @extended=" & @extended & @CRLF & @CRLF & _TS_ErrorText(@error))
EndIf
_TS_Close()